Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump typedoc-plugin-markdown from 4.0.2 to 4.3.0 #1067

Closed

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 27, 2024

Bumps typedoc-plugin-markdown from 4.0.2 to 4.3.0.

Release notes

Sourced from typedoc-plugin-markdown's releases.

[email protected]

Minor Changes

  • Implemented typedoc 0.27 compatibility support.
  • Exposed "typeDeclarationVisibility" option to provide a "compact" output structure (#703).
  • Exposed "pageTitleTemplates" option that accepts a string with placeholder or function arguments to control page titles (#715).
  • Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of output if Prettier is installed on a project.

Patch Changes

  • Improved structure of curried and overloaded signatures (#714) (#718)
  • The "hideGroupHeadings" option respects group order (#716)
  • Handle Optional types correctly (#719).

[email protected]

Patch Changes

  • Enhanced the formatting and structure of accessor output (#711)

[email protected]

Patch Changes

  • Expose @return block tags on declarations (#694)
  • Add parentheses on function names in type declaration table views (#696)

[email protected]

Patch Changes

  • Fix missing slash when public path is prefixed with http (#688)

[email protected]

Patch Changes

  • Correctly handle top level custom groups in navigation (#685)
  • Fix missing index descriptions for some signatures (#670)
  • Add '?' for optional type declarations in tables

[email protected]

Patch Changes

  • Expose missing entrypoints to navigation (#663)
  • Fix missing function descriptions in indexes

[email protected]

Patch Changes

  • Expose comment for arrow functions in type declarations (#670)
  • Tables generated with the "htmlTable" key will include <thead> and <tbody> elements to fix MDX compatibility issues (#671)
  • Expose missing descriptions with accessor keyword (#664)

... (truncated)

Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.3.0 (2024-11-27)

This release introduces support for TypeDoc 0.27 and some additional UX features and improvements in addition to some bug fixes.

TypeDoc 0.27 Support

Please see for full TypeDoc changelog for additional information.

There are two TypeDoc breaking changes that might effect users of this plugin:

  • TypeDoc has converted to ESM and therefore all public and local CommonJs plugins will need to be refactored to ESM.
  • TypeScript <5.0 is no longer supported.

UX Changes

  • Parameters list views have been updated to separate params with markdown headings to improve readability when parameters have detailed explanations examples, or sub-properties. If parameters are straightforward and few in number switching to parametersFormat=table might be preferable.
  • Improved structure of curried and overloaded signatures.
  • Page headings have been simplified to simply display project title as per default theme.

Features

  • Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of Markdown if Prettier is installed on a project.
  • Exposed "typeDeclarationVisibility" option to provide a "compact" output structure (#703).
  • Exposed "pageTitleTemplates" option that accepts a string with placeholder or function arguments to control page titles (#715).

Patch Changes

  • Improved structure of curried and overloaded signatures (#714) (#718)
  • The "hideGroupHeadings" option respects group order (#716)
  • Handle Optional types correctly (#719).

4.2.10 (2024-11-01)

Patch Changes

  • Enhanced the formatting and structure of accessor output (#711)

4.2.9 (2024-10-01)

Patch Changes

  • Expose @return block tags on declarations (#694)
  • Add parentheses on function names in type declaration table views (#696)

4.2.8 (2024-09-22)

Patch Changes

  • Fix missing slash when public path is prefixed with http (#688)

... (truncated)

Commits
  • 19c21a3 Version Packages
  • fbfd19b chore(all): final output tweaks
  • 5e95bba chore(core): updated docs
  • e2a3467 feat(core): exposed formatting with prettier options
  • a667e80 chore(all): updated typedoc
  • b323a8a feat(core): improve parameter and type declaration listings
  • 1d33b64 fix(core): handle optional types correctly
  • a0e2ff9 fix(core): updated default output as per updated api
  • 142ced6 fix(core): tweaked signature overloads
  • e59d55c fix(core): fix comments and clarify headings for overload and curried methods...
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript labels Nov 27, 2024
Copy link
Contributor Author

dependabot bot commented on behalf of github Dec 3, 2024

Superseded by #1071.

@dependabot dependabot bot closed this Dec 3, 2024
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/typedoc-plugin-markdown-4.3.0 branch December 3, 2024 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants